package com.github.cyf.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author chenyifan
 * @create 2024-03-26 15:18
 */
@Configuration
@EnableKnife4j
public class Knife4jConfig {

    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.OAS_30)
                .enable(true)
                .apiInfo(new ApiInfoBuilder()
                        .title("项目 Restful API 说明文档")
                        .contact(new Contact("cyf", "https://www.baidu.com/", "cyf1230330@163.com"))
                        .description("基于Swagger2和Knife4j实现的接口文档")
                        .termsOfServiceUrl("http://localhost:8080/")
                        .version("1.0")
                        .build()
                )
                // 分组名称
                .groupName("default")
                // 选择哪些接口作为swagger的doc发布
                .select()
                // 配置 Swagger 扫描 API 接口的基础包路径，
                // 它会扫描指定包及其子包下的所有带有 @Api 注解的 Controller 类，识别出其中的 Restful API 资源
                .apis(RequestHandlerSelectors.basePackage("com.github.cyf.controller"))
                // 只包含路径以/api/开头的所有接口
                .paths(PathSelectors.ant("/**"))
                .build();
    }
}